Table Operations

Read Operations Description

GetTableEntries

Returns the list of associated table entries and their attributes, for a given service name (TRS or UIS) and a specific table name.

The return XML will indicate success or failure.

GetTableNames

Returns the list of all table names configured in the TRS, for a given service name (TRS or UIS).

The return XML will indicate success or failure.

GetUdcCategories

Returns a list of UDC categories configured in the TRS, given a service name (TRS or UIS).

The return XML will indicate success or failure.

GetUdcInfo

Returns the attributes of the specified UDC, given a service name (TRS or UIS) and a specific UDC.

The return XML will indicate success or failure.

GetUdcListForCategories

Returns the list of UDC attributes associated with the category in the TRS, given a service name (TRS or UIS) and a specific UDC category.

The return XML will indicate success or failure.

Write Operations Description

AddTables

Adds the table definitions to the TRS, given a service name (TRS or UIS) and a list of table attributes.

The return XML will indicate success or failure.

AddTableEntries

Adds the specified table entries to the specified table, given a service name (TRS or UIS), a table ID and a list of table entry attributes.

The return XML will indicate success or failure.

UpdateTableEntries

Updates the specified table entries, given a service name (TRS of UIS), and a list of table IDs and associated table entry IDs/update parameters.

The return XML will indicate success or failure.

DeleteTables

Deletes the specified table definitions along with the associated table entries, given a service name (TRS or UIS) and a table ID.

The return XML will indicate success or failure.

DeleteTableEntries

Deletes the specified table entry from the specified table, for a given service name (TRS or UIS), a table ID and a table entry ID.

The return XML will indicate success or failure.

GetTableEntries

Given a service name (TRS or UIS) and a list of table names, this operation will return the list of associated table entries and their attributes for each specified table name. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetTableEntriesReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

TableName

Yes

The name of the table for which to retrieve entries.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request
Copy
GetTableEntries Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations  xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <GetTableEntriesReq>
        <SvcName>CYGDEMO.TRS</SvcName>
        <TableName>ACTIVE</TableName>
        <TableName>CMDEVICE</TableName>
        <TableName>CMEXTTYP</TableName>
    </GetTableEntriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

Copy
GetTableEntries Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetTableEntriesResp>
        <SvcName>CYGDEMO.TRS</SvcName>
        <TableNamesAndEntries>
            <TableNameAndEntries>
                <TableName>ACTIVE</TableName>
                <TableEntries>
                    <TableEntry>
                        <TableEntryName>N</TableEntryName>
                        <TableEntryAttributes>
                            <Description>Inactive</Description>
                            <FormatData></FormatData>
                            <Active>true</Active>
                        </TableEntryAttributes>
                    </TableEntry>
                    <TableEntry>
                        <TableEntryName>Y</TableEntryName>
                        <TableEntryAttributes>
                            <Description>Active</Description>
                            <FormatData></FormatData>
                            <Active>true</Active>
                        </TableEntryAttributes>
                    </TableEntry>
                </TableEntries>
            </TableNameAndEntries>
            <TableNameAndEntries>
                <TableName>CMDEVICE</TableName>
                <TableEntries>
                    <TableEntry>
                    <TableEntryName>N/A</TableEntryName>
                    <TableEntryAttributes>
                        <Description>&lt;N/A&gt;</Description>
                        <FormatData></FormatData>
                        <Active>true</Active>
                    </TableEntryAttributes>
                </TableEntry>
                </TableEntries>
            </TableNameAndEntries>
            <TableNameAndEntries>
                <TableName>CMEXTTYP</TableName>
                <TableEntries>
                    <TableEntry>
                        <TableEntryName>N/A</TableEntryName>
                        <TableEntryAttributes>
                            <Description>&lt;N/A&gt;</Description>
                            <FormatData></FormatData>
                            <Active>true</Active>
                        </TableEntryAttributes>
                    </TableEntry>
                </TableEntries>
            </TableNameAndEntries>
        </TableNamesAndEntries>
        <OperationResults success="true" resp_timestamp="2023-01-12T23:43:43.318Z" exec_duration="PT0.743S" />
    </GetTableEntriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
GetTableEntries Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetTableEntriesResp>
    <SvcName>CYGDEMO.TRS</SvcName>
    <TableNamesAndEntries/>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:13:38.364Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
     </GetTableEntriesResp>
</CygNetEnterpriseOperations>

Back to top

GetTableNames

Given a service name (TRS or UIS), this operation will return the list of all table names configured in the TRS. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetTableNamesReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request
Copy
GetTableNames Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations  xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn" >
    <GetTableNamesReq>
        <SvcName>CYGDEMO.TRS</SvcName>
    </GetTableNamesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

Copy
GetTableNames Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetTableNamesResp>
        <SvcName>CYGDEMO.TRS</SvcName>
        <TableNames>
            <TableName>ACTIVE</TableName>
            <TableName>CMDEVICE</TableName>
            <TableName>CMEXTTYP</TableName>
            <TableName>CMINITYP</TableName>
            <TableName>CMPNTREF</TableName>
            <TableName>CMPORT</TableName>
            <TableName>CMPTYPE</TableName>
            <TableName>CMSYS</TableName>
            <TableName>CMT1</TableName>
            <TableName>COMSTATE</TableName>
            <TableName>EDITMODE</TableName>
            <TableName>ELSETYPE</TableName>
            <TableName>ELSNEWET</TableName>
            <TableName>FACINFO</TableName>
            <TableName>GNSTYPE</TableName>
            <TableName>METRSTAT</TableName>
            <TableName>PCSDISP</TableName>
            <TableName>PNTALCAT</TableName>
            <TableName>SVMACTST</TableName>
            <TableName>SVMCYCST</TableName>
            <TableName>SYSFCCAT</TableName>
            <TableName>SYSFCTYP</TableName>
            <TableName>UISSPOLL</TableName>
            <TableName>YORN</TableName>
            <TableName>~UDCALL</TableName>
            <TableName>~UDCALM</TableName>
            <TableName>~UDCANLG</TableName>
            <TableName>~UDCAUD</TableName>
            <TableName>~UDCCALC</TableName>
            <TableName>~UDCCAT</TableName>
            <TableName>~UDCCNT</TableName>
            <TableName>~UDCCOM</TableName>
            <TableName>~UDCCTRL</TableName>
            <TableName>~UDCDGTL</TableName>
            <TableName>~UDCEVT</TableName>
            <TableName>~UDCFLWA</TableName>
            <TableName>~UDCFTIM</TableName>
            <TableName>~UDCGASA</TableName>
            <TableName>~UDCHIST</TableName>
            <TableName>~UDCHURR</TableName>
            <TableName>~UDCINS</TableName>
            <TableName>~UDCLEVL</TableName>
            <TableName>~UDCPOC</TableName>
            <TableName>~UDCPRDH</TableName>
            <TableName>~UDCPRSS</TableName>
            <TableName>~UDCQUAN</TableName>
            <TableName>~UDCRATE</TableName>
            <TableName>~UDCREVT</TableName>
            <TableName>~UDCROC</TableName>
            <TableName>~UDCSPD</TableName>
            <TableName>~UDCSPRM</TableName>
            <TableName>~UDCSTAT</TableName>
            <TableName>~UDCSVM</TableName>
            <TableName>~UDCSYS</TableName>
            <TableName>~UDCTEMP</TableName>
            <TableName>~UDCTIME</TableName>
            <TableName>~UDCVALV</TableName>
            <TableName>~UDCVOLT</TableName>
            <TableName>~UDCWELL</TableName>
        </TableNames>
        <OperationResults success="true" resp_timestamp="2023-01-12T23:00:22.017Z" exec_duration="PT0.194S" />
    </GetTableNamesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
GetTableNames Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetTableNamesResp>
        <SvcName>CYGDEMO.TRS</SvcName>
        <TableNames />
        <OperationResults success="false" resp_timestamp="2023-11-09T04:37:05.351Z" exec_duration="PT0.025S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </GetTableNamesResp>
</CygNetEnterpriseOperations>

Back to top

GetUdcCategories

Given a service name (TRS or UIS), this operation will return the list of UDC categories configured in the TRS. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetUdcCategoriesReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request
Copy
GetUdcCategories Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <GetUdcCategoriesReq>
        <SvcName>CYGDEMO.TRS</SvcName>
    </GetUdcCategoriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

Copy
GetUdcCategories Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcCategoriesResp>
        <SvcName>CYGDEMO.TRS</SvcName>
        <UdcCategories>
            <UdcCategory>SVMCYCST</UdcCategory>
            <UdcCategory>~UDCALL</UdcCategory>
            <UdcCategory>~UDCALM</UdcCategory>
            <UdcCategory>~UDCANLG</UdcCategory>
            <UdcCategory>~UDCAUD</UdcCategory>
            <UdcCategory>~UDCCALC</UdcCategory>
            <UdcCategory>~UDCCNT</UdcCategory>
            <UdcCategory>~UDCCOM</UdcCategory>
            <UdcCategory>~UDCCTRL</UdcCategory>
            <UdcCategory>~UDCDGTL</UdcCategory>
            <UdcCategory>~UDCEVT</UdcCategory>
            <UdcCategory>~UDCFLWA</UdcCategory>
            <UdcCategory>~UDCFTIM</UdcCategory>
            <UdcCategory>~UDCGASA</UdcCategory>
            <UdcCategory>~UDCHIST</UdcCategory>
            <UdcCategory>~UDCHURR</UdcCategory>
            <UdcCategory>~UDCINS</UdcCategory>
            <UdcCategory>~UDCLEVL</UdcCategory>
            <UdcCategory>~UDCPOC</UdcCategory>
            <UdcCategory>~UDCPRDH</UdcCategory>
            <UdcCategory>~UDCPRSS</UdcCategory>
            <UdcCategory>~UDCQUAN</UdcCategory>
            <UdcCategory>~UDCRATE</UdcCategory>
            <UdcCategory>~UDCREVT</UdcCategory>
            <UdcCategory>~UDCROC</UdcCategory>
            <UdcCategory>~UDCSPD</UdcCategory>
            <UdcCategory>~UDCSPRM</UdcCategory>
            <UdcCategory>~UDCSTAT</UdcCategory>
            <UdcCategory>~UDCSVM</UdcCategory>
            <UdcCategory>~UDCSYS</UdcCategory>
            <UdcCategory>~UDCTEMP</UdcCategory>
            <UdcCategory>~UDCTIME</UdcCategory>
            <UdcCategory>~UDCVALV</UdcCategory>
            <UdcCategory>~UDCVOLT</UdcCategory>
            <UdcCategory>~UDCWELL</UdcCategory>
        </UdcCategories>
        <OperationResults success="true" resp_timestamp="2023-01-15T01:13:45.762Z" exec_duration="PT3.719S" />
    </GetUdcCategoriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
GetUdcCategories Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcCategoriesResp>
    <SvcName>CYGDEMO.TRS</SvcName>
    <UdcCategories />
        <OperationResults success="false" resp_timestamp="2023-11-09T04:43:12.072Z" exec_duration="PT0.004S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </GetUdcCategoriesResp>
</CygNetEnterpriseOperations>

Back to top

GetUdcInfo

Given a service name (TRS or UIS) and a list of UDCs, this operation will return the attributes of the specified UDCs. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetUdcInfoReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

UdcNames

Yes

A list of UDCs for which to retrieve attributes.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request
Copy
GetUdcInfo Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations  xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <GetUdcInfoReq>
    <SvcName>CYGDEMO.TRS</SvcName>
        <UdcNames>
            <UdcName>ACC00</UdcName>
            <UdcName>ACC01</UdcName>
            <UdcName>ACCUM</UdcName>
            <UdcName>AIN</UdcName>
        </UdcNames>
    </GetUdcInfoReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

Copy
GetUdcInfo Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcInfoResp>
        <SvcName>CYGDEMO.TRS</SvcName>
        <Udcs>
            <Udc>
                <UdcName>ACC00</UdcName>
                <Description>Accumulator 00</Description>
                <UdcAssocs>
                    <UdcAssoc>
                        <UdcCategory>~UDCALL</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                    <UdcAssoc>
                        <UdcCategory>~UDCCNT</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                </UdcAssocs>
            </Udc>
            <Udc>
                <UdcName>ACC01</UdcName>
                <Description>Accumulator 01</Description>
                <UdcAssocs>
                    <UdcAssoc>
                        <UdcCategory>~UDCALL</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                    <UdcAssoc>
                        <UdcCategory>~UDCCNT</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                </UdcAssocs>
            </Udc>
            <Udc>
                <UdcName>ACCUM</UdcName>
                <Description>Accumulator</Description>
                <UdcAssocs>
                    <UdcAssoc>
                        <UdcCategory>~UDCALL</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                    <UdcAssoc>
                        <UdcCategory>~UDCCNT</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                </UdcAssocs>
            </Udc>
            <Udc>
                <UdcName>AIN</UdcName>
                <Description>Analog Input</Description>
                <UdcAssocs>
                    <UdcAssoc>
                        <UdcCategory>~UDCALL</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                    <UdcAssoc>
                        <UdcCategory>~UDCANLG</UdcCategory>
                        <FormatData></FormatData>
                    </UdcAssoc>
                </UdcAssocs>
            </Udc>
        </Udcs>
        <OperationResults success="true" resp_timestamp="2023-01-15T01:05:35.051Z" exec_duration="PT4.072S" />
    </GetUdcInfoResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
GetUdcInfo Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcInfoResp>
    <SvcName>CYGDEMO.TRS</SvcName>
    <Udcs />
        <OperationResults success="false" resp_timestamp="2023-11-09T04:47:43.100Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </GetUdcInfoResp>
</CygNetEnterpriseOperations>

Back to top

GetUdcListForCategories

Given a service name (TRS or UIS) and a list of UDC categories, this operation will return the list of UDCs and attributes associated with the categories in the TRS. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetUdcListForCategoriesReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

UdcCategories

Yes

A list of UDC categories for which to retrieve UDCs.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request
Copy
GetUdcListForCategories Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn" >
    <GetUdcListForCategoriesReq>
        <SvcName>CYGDEMO.TRS</SvcName>
        <UdcCategories>
            <UdcCategory>SVMCYCST</UdcCategory>
            <UdcCategory>~UDCALM</UdcCategory>
        </UdcCategories>
    </GetUdcListForCategoriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

Copy
GetUdcListForCategories Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcListForCategoriesResp>
        <UdcList UdcCategory="SVMCYCST">
            <UDC>0</UDC>
            <UDC>1</UDC>
            <UDC>2</UDC>
            <UDC>3</UDC>
        </UdcList>
        <UdcList UdcCategory="~UDCALM">
            <UDC>ALMCD</UDC>
            <UDC>ALMCODRAW</UDC>
            <UDC>ALMDA</UDC>
            <UDC>ALMDATE</UDC>
            <UDC>ALMDESC</UDC>
            <UDC>ALMDT</UDC>
            <UDC>ALMPT</UDC>
            <UDC>ALMRN</UDC>
            <UDC>ALMTAG</UDC>
            <UDC>ALMTYPE</UDC>
            <UDC>ALMTYPRAW</UDC>
            <UDC>ALMVAL</UDC>
        </UdcList>
        <OperationResults success="true" resp_timestamp="2023-03-31T23:21:34.656Z" exec_duration="PT4.909S" />
    </GetUdcListForCategoriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
GetUdcListForCategories Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <GetUdcListForCategoriesResp>
        <OperationResults success="false" resp_timestamp="2023-11-09T04:56:18.903Z" exec_duration="PT0.005S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </GetUdcListForCategoriesResp>
</CygNetEnterpriseOperations>

Back to top

AddTables

Given a service name (TRS or UIS) and a list of table names and attributes, this operation will add the table definitions to the TRS. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<AddTablesReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to add a table.  Otherwise, the operation will terminate immediately upon failing to add a table.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Table

Yes

The table data to add to the TRS.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to add a table that already exists.

Copy
AddTables Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <AddTablesReq>
        <AllowPartialFailure>true</AllowPartialFailure>
        <SvcName>CYGDEMO.TRS</SvcName>
        <Table>
            <TableName>TSTTBL</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTENTRY</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL1</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTENTRY</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTENTRY1</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL2</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTENTRY</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTENTRY1</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            <TableEntry>
                <TableEntryName>TESTENTRY2</TableEntryName>
                <TableEntryAttributes>
                    <Description>This is a test entry</Description>
                </TableEntryAttributes>
            </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>IEXIST</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>BLAH</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
    </AddTablesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with a warning to indicate that a table named "IEXIST" already exists.

Copy
AddTables Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <AddTablesResp>
        <OperationResults success="true" resp_timestamp="2023-05-20T21:30:53.482Z" exec_duration="PT0.245S">
            <OperationResult type="WARNING" code="50430">Table IEXIST already exists</OperationResult>
        </OperationResults>
    </AddTablesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
AddTables Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <AddTablesResp>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:11:40.084Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS2</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </AddTablesResp>
</CygNetEnterpriseOperations>

Back to top

AddTableEntries

Given a service name (TRS or UIS), a table name, and a list of table entry attributes, this operation will add the specified table entry to the specified table. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<AddTableEntriesReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to add a table entry.  Otherwise, the operation will terminate immediately upon failing to add a table entry.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Table

Yes

The table data to add to the TRS.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to add a table entry that already exists, and attempting to add an entry to a table that does not exist.

Copy
AddTableEntries Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <AddTableEntriesReq>
        <AllowPartialFailure>true</AllowPartialFailure>
        <SvcName>CYGDEMO.TRS</SvcName>
        <Table>
            <TableName>TSTTBL</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL1</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL2</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD2</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>IEXIST</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>IEXIST</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>NOTEXIST</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>BLAH</TableEntryName>
                    <TableEntryAttributes>
                        <Description>This is a test entry</Description>
                    </TableEntryAttributes>
                </TableEntry>
            </TableEntries>
        </Table>
    </AddTableEntriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with warnings to indicate that an entry named "IEXIST" already exists in table "IEXIST", and table "NOTEXIST" does not exist.

Copy
AddTableEntries Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <AddTableEntriesResp>
        <OperationResults success="true" resp_timestamp="2023-05-20T21:31:55.467Z" exec_duration="PT0.285S">
            <OperationResult type="WARNING" code="50432">Entry IEXIST already exists in table IEXIST</OperationResult>
            <OperationResult type="WARNING" code="50429">Table NOTEXIST does not exist</OperationResult>
        </OperationResults>
    </AddTableEntriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
AddTableEntries Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <AddTableEntriesResp>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:11:45.224Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS2</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </AddTableEntriesResp>
</CygNetEnterpriseOperations>

Back to top

UpdateTableEntries

Given a service name (TRS or UIS) and a list of table entry attribute updates, this operation will update the specified table entry attributes. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<UpdateTableEntriesReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to update a table entry.  Otherwise, the operation will terminate immediately upon failing to update a table entry.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Table

Yes

The table data to update in the TRS.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to rename a table to an existing name, attempting to rename an entry to an existing entry name, attempting to update an entry that does not exist, and attempting to update an entry in a table that does not exist.

Copy
UpdateTableEntries Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <UpdateTableEntriesReq>
        <AllowPartialFailure>true</AllowPartialFailure>
        <SvcName>CYGDEMO.TRS</SvcName>
        <Table>
            <TableName>TSTTBL</TableName>
            <NewTableName>NEWTBL</NewTableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <TableEntryName>TESTADDNEW</TableEntryName>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL1</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <Description>New description</Description>
                    <Active>false</Active>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <Active>0</Active>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL2</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <Active>1</Active>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <Description>New description</Description>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD2</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <Description>New description</Description>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>NOTEXIST</TableName>
            <NewTableName>BLAH</NewTableName>
        </Table>
        <Table>
            <TableName>TSTTBL2</TableName>
            <NewTableName>TSTTBL1</NewTableName>
        </Table>
        <Table>
            <TableName>IEXIST</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>IEXIST</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <TableEntryName>IEXIST2</TableEntryName>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>NOTEXIST</TableEntryName>
                    <TableEntryAttributesToUpdate>
                    <TableEntryName>BLAH</TableEntryName>
                    </TableEntryAttributesToUpdate>
                </TableEntry>
            </TableEntries>
        </Table>
    </UpdateTableEntriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with warnings to indicate failures updating entries.

Copy
UpdateTableEntries Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <UpdateTableEntriesResp>
        <OperationResults success="true" resp_timestamp="2023-05-20T21:38:08.986Z" exec_duration="PT0.912S">
            <OperationResult type="WARNING" code="50430">Table TSTTBL1 already exists</OperationResult>
            <OperationResult type="WARNING" code="50432">Entry IEXIST2 already exists in table IEXIST</OperationResult>
            <OperationResult type="WARNING" code="50431">Entry NOTEXIST does not exist in table IEXIST</OperationResult>
            <OperationResult type="WARNING" code="50429">Table NOTEXIST does not exist</OperationResult>
        </OperationResults>
    </UpdateTableEntriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
UpdateTableEntries Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <UpdateTableEntriesResp>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:11:53.540Z" exec_duration="PT0.003S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS1</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </UpdateTableEntriesResp>
</CygNetEnterpriseOperations>

Back to top

DeleteTables

Given a service name (TRS or UIS) and a list of table names, this operation will delete the specified table definitions along with the associated table entries. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<DeleteTablesReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to delete a table.  Otherwise, the operation will terminate immediately upon failing to delete a table.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

TableName

Yes

The table name to delete from the TRS.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to delete a table that does not exist.

Copy
DeleteTables Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations  xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn" >
    <DeleteTablesReq>
        <AllowPartialFailure>true</AllowPartialFailure>
        <SvcName>CYGDEMO.TRS</SvcName>
        <TableName>NEWTBL</TableName>
        <TableName>TSTTBL1</TableName>
        <TableName>TSTTBL2</TableName>
        <TableName>NOTEXIST</TableName>
    </DeleteTablesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with a warning to indicate that a table named "NOTEXIST" does not exist.

Copy
DeleteTables Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <DeleteTablesResp>
        <OperationResults success="true" resp_timestamp="2023-05-20T21:50:49.877Z" exec_duration="PT0.287S">
            <OperationResult type="WARNING" code="50429">Table NOTEXIST does not exist</OperationResult>
        </OperationResults>
    </DeleteTablesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
DeleteTables Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <DeleteTablesResp>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:12:03.414Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS3</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </DeleteTablesResp>
</CygNetEnterpriseOperations>

Back to top

DeleteTableEntries

Given a service name (TRS or UIS) and a list of table names and table entry names, this operation will delete the specified table entries from the specified tables. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<DeleteTableEntriesReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to delete a table entry.  Otherwise, the operation will terminate immediately upon failing to delete a table entry.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Table

Yes

The table data to delete from the TRS.  This element can be used multiple times.

Target Services

The service name node (<SvcName>) must specify the name of a TRS or UIS Site.Service. If a UIS is specified, the service will resolve to its associated TRS.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to delete a table entry that does not exist, and attempting to delete an entry from a table that does not exist.

Copy
DeleteTableEntries Request
<?xml version="1.0"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn"  >
    <DeleteTableEntriesReq>
        <AllowPartialFailure>true</AllowPartialFailure>
        <SvcName>CYGDEMO.TRS</SvcName>
        <Table>
            <TableName>NEWTBL</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADDNEW</TableEntryName>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL1</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>TSTTBL2</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>TESTADD</TableEntryName>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD1</TableEntryName>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>TESTADD2</TableEntryName>
                </TableEntry>
                <TableEntry>
                    <TableEntryName>NOTEXIST</TableEntryName>
                </TableEntry>
            </TableEntries>
        </Table>
        <Table>
            <TableName>NOTEXIST</TableName>
            <TableEntries>
                <TableEntry>
                    <TableEntryName>BLAH</TableEntryName>
                </TableEntry>
            </TableEntries>
        </Table>
    </DeleteTableEntriesReq>
</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with warnings to indicate failures deleting entries.

Copy
DeleteTableEntries Response
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <DeleteTableEntriesResp>
        <OperationResults success="true" resp_timestamp="2023-05-20T21:48:20.112Z" exec_duration="PT0.260S">
            <OperationResult type="WARNING" code="50429">Table NOTEXIST does not exist</OperationResult>
            <OperationResult type="WARNING" code="50431">Entry BLAH does not exist in table NOTEXIST</OperationResult>
            <OperationResult type="WARNING" code="50431">Entry NOTEXIST does not exist in table TSTTBL2</OperationResult>
        </OperationResults>
    </DeleteTableEntriesResp>
</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

Copy
DeleteTableEntries Response Unsuccessful
<?xml version="1.0" encoding="UTF-8"?>
<CygNetEnterpriseOperations xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjectsnnn">
    <DeleteTableEntriesResp>
        <OperationResults success="false" resp_timestamp="2023-07-30T22:11:58.430Z" exec_duration="PT0.002S">
            <OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS3</OperationResult>
            <OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>
        </OperationResults>
    </DeleteTableEntriesResp>
</CygNetEnterpriseOperations>

Back to top